Area Groups
Table Name: GXT_AREAGROUPS_TBL
List
Request a list of area groups.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_AREAGROUPS_TBL
-
Response:
Copy13=Area Group 1
Detail
Request the details of a specific area group.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_AREAGROUPS_TBL&RecId=<RecId>
-
Response:
CopyAreaGroupId=13&Name=Area Group 1&IncludeAllAreasEx=false&AreaId0=16&AreaId1=17
Update
Update a specific area group.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_AREAGROUPS_TBL&AreaGroupId=1&Name=Manager Areas
-
Response:
CopyOK
Create
Create an area group. To create an area group, use the same parameters as update but leave the AreaGroupId empty.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_AREAGROUPS_TBL&AreaGroupId=&Name=Manager Areas&IncludeAllAreasEx=false&Area1=27&Area2=30
-
Response:
CopyOK
Delete
Delete a specific area group.
-
Request:
Copyhttp://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Delete&SubType=GXT_AREAGROUPS_TBL&RecId=<RecId>
-
Response:
CopyOK
Parameters
Parameter |
Display Name |
Default Value |
Description |
---|---|---|---|
AreaGroupId |
Database ID |
13 |
The Detail, Control and Delete APIs use this value as the RecId. |
Name |
Name |
Area Group 1 |
|
IncludeAllAreasEx |
|
false |
This is a legacy option that has no effect. |
AreaId* |
Areas |
16 |
|
Parameters that contain multiple values are documented as <Parameter Name>*, where * is the index of the value. See Programming.